widgets.brease.ProgressBar

Widget Description

short: Balkenanzeige
de: Zeigt einen numerischen Wert als Balken an
en: Displays a numeric value as a bar

Properties

name description category type defaultValue bindable readOnly required localizable editableBinding projectable cssProp (has no setter and getter in JS) groupRefId groupOrder nodeRefId (for linking node and value) deprecated typeRefId (for StyleReference) subtype (for MpComIdentReference)
barAnimation Set to TRUE to enable animation of the progress bar when styled as "striped" Behavior Boolean false false false false false false true
enable Initial option to enable widget. Behavior Boolean true true false false false false true
labelPosition Location of the output label text-field. Possible values: right, left, middle, center, top, bottom Appearance brease.enum.Position right false false false false false true Label 2
labelSize Width of unit area. Appearance Size 30 false false false false false true Label
maxValue Maximum value for the bound variable. Behavior Number 100 true false false false false true
minValue Minimum value for the bound variable. Behavior Number 0 true false false false false true
node Display value with unit and limits. Data brease.datatype.Node true false false false false true
orientation Orientation of widget Appearance brease.enum.Orientation LeftToRight false false false false false true
permissionOperate restricts operability to users, which have given roles Accessibility RoleCollection no defaultValue
defined		 false false false false false true
permissionView restricts visibility to users, which have given roles Accessibility RoleCollection no defaultValue
defined		 false false false false false true
showLabel Controls the visibility of the percentage label text-field. Appearance Boolean true false false false false false true Label 1
stripedProgressBar Applies a striped styling to the progress bar. Appearance Boolean false false false false false false true Bar 6
style reference to a style for this widget type Appearance StyleReference default true false false false false true
tabIndex sets if a widget should have autofocus enabled (0), the order of the focus (>0), or if autofocus should be disabled (-1) Behavior Integer -1 false false false false false true
tooltip reference to a tooltip for a widget Appearance String false false false true false true
transitionTime Defines the time (in ms) used for the transition to a new bar value Behavior UInteger 500 false false false false false true
value Initial visible value of widget as a number Data Number 0 true false false false false true node
visible change visibility Behavior Boolean true true false false false false true
maxHeight maximum outer height of widget Size 0 false false false true true
minHeight minimum outer height of widget Size 0 false false false true true
maxWidth maximum outer width of widget Size 0 false false false true true
minWidth minimum outer width of widget Size 0 false false false true true
zIndex The zIndex property specifies the z-order of a widget and its childs.
When widgets overlap, z-order determines which one covers the other. A widget with a larger zIndex generally covers a widget with a lower one.
The zIndex must be unique within a content.
 UInteger no defaultValue
defined		 false false true true true
left absolute position measured from left boundary of parent container Integer no defaultValue
defined		 false false false true true
top absolute position measured from top boundary of parent container Integer no defaultValue
defined		 false false false true true
height Outer height of widget, in pixels Size 25 false false false true true
width Outer width of widget, in pixels Size 400 false false false true true

Styleable Properties

name type description defaultValue
opacity Opacity

Opacity of the widget: 1 - opaque, 0 - fully transparent.

 1
padding Padding

Internal padding for the ProgressBar widget.

 0px
margin Margin

Outer margin of the ProgressBar widget.

 0px
shadow Shadow

Shadow of the widget - see css "box-shadow" for more information.

 none
barBorderStyle BorderStyle

Sets the style of the Border of the widget. Check css "border-style" property for more information.

 none
barBorderWidth PixelValCollection

Sets the width of the border. Check css "border-width" property for more information.

 1px
barBorderColor Color

Sets the border color for the bar. Check css "border-color" property for more information.

 #000000
barCornerRadius PixelValCollection

Sets the radius of the widget rounded corners. Check css "border-radius" property for more information.

 20px
barBackColor Color

Sets the background color of the bar element of the widget.

 #E0E0E0
barBackGroundGradient Gradient

Defines a gradient for the background of the progress bar.
barColor Color

Sets the fore color of the bar element of the widget.

 #FF8800
barGradient Gradient

Defines a gradient background for the progress bar portion.
borderStyle BorderStyle

Sets the style of the outer border of the widget. Check css "border-style" property for more information.

 solid
borderWidth PixelValCollection

Sets the width of the outer border of the widget. Check css "border-width" property for more information.

 1px
borderColor Color

Sets the border color for the outer area of the widget.

 #000000
cornerRadius PixelValCollection

Sets the radius of the widget corners. Check css "border-radius" property for more information.

 4px
backColor Color

Sets the background color of the outer widget container.

 transparent
fontName FontName

Font name for the ProgressBar text fields.

 Arial
fontSize PixelVal

Font size of the ProgressBar text fields, in pixels.

 12px
fontColor Color

Sets the color of the text.

 #000000
bold Boolean

If TRUE, font style is configured as bold.

 false

Events

name description arguments
Click Fired when element is clicked on.
  • origin: String

    id of widget that triggered this event

  • horizontalPos: String

    horizontal position of click in pixel i.e '10px'

  • verticalPos: String

    vertical position of click in pixel i.e '10px'

DisabledClick Fired when disabled element is clicked on.
  • origin: String

    id of widget that triggered this event

  • hasPermission: Boolean

    defines if the state is caused due to missing roles of the current user

  • horizontalPos: String

    horizontal position of click in pixel i.e '10px'

  • verticalPos: String

    vertical position of click in pixel i.e '10px'

EnableChanged Fired when operability of the widget changes.
  • value: Boolean

    operability

FocusIn Fired when the widgets gets focus
FocusOut Fired when the widgets lost focus
MaxValueReached Fired once when maximum value is reached.
  • value: Boolean

    value reflects the state of the "value" property >= maxValue.

MinValueReached Fired once when minimum value is reached.
  • value: Boolean

    value reflects the state of the "value" property <= minValue.

OnDragEnter Fired when element has onDragEnter.
  • contentId: String

    content id of the widget that has been entering the droppable widget

  • widgetId: String

    id of the widget that has been entering the droppable widget

OnDragLeave Fired when element has OnDragLeave.
  • contentId: String

    content id of the widget that has been leaving the droppable widget

  • widgetId: String

    id of the widget that has been leaving the droppable widget

OnDrop Fired when element has OnDrop.
  • contentId: String

    content id of the widget that has been dropped on the droppable widget

  • widgetId: String

    id of the widget that has been dropped on the droppable widget

VisibleChanged Fired when the visibility of the widget changes.
  • value: Boolean

    visibility

Actions

name description arguments result
Focus Sets focus on the widget element, if it can be focused and keyboardOperation=true
SetEnable Sets the state of property «enable»
  • value: Boolean

SetMaxValue sets the maximum value of the ProgressBar number range
  • value: Number

SetMinValue sets the mininum value of the ProgressBar number range
  • value: Number

SetStyle
  • value: StyleReference

SetValue set the actual value
  • value: Number

SetVisible Sets the state of property «visible»
  • value: Boolean

ShowTooltip